core/androidx.core.view/[main]MenuHostHelper

MenuHostHelper

Helper class for implementing MenuHost. This class should be used to implement the MenuHost functions. i.e.:

class ExampleComponent : MenuHost {

    private val menuHostHelper = MenuHostHelper{ invalidateMenu() }

    override fun invalidateMenu() { … }

    override fun addMenuProvider(provider: MenuProvider, owner: LifecycleOwner) {
        menuHostHelper.addMenuProvider(provider, owner)
    }

    // Override remaining MenuHost methods in similar fashion
}

Constructors

MenuHostHelper

constructor(@NonNull onInvalidateMenuCallback: @NonNull Runnable)

Construct a new MenuHostHelper.

Functions

addMenuProvider

open fun addMenuProvider(@NonNull provider: @NonNull MenuProvider)

open fun addMenuProvider(@NonNull provider: @NonNull MenuProvider, @NonNull owner: @NonNull LifecycleOwner)

Adds the given MenuProvider to the helper.

open fun addMenuProvider(@NonNull provider: @NonNull MenuProvider, @NonNull owner: @NonNull LifecycleOwner, state: @NonNull Lifecycle.State)

Adds the given MenuProvider to the helper once the given LifecycleOwner reaches the given Lifecycle.State.

onCreateMenu

open fun onCreateMenu(@NonNull menu: @NonNull Menu, @NonNull menuInflater: @NonNull MenuInflater)

Inflates the entire Menu, which will include all MenuItems provided by all current MenuProviders.

onMenuClosed

open fun onMenuClosed(@NonNull menu: @NonNull Menu)

Called when the given Menu, which was provided by one of the current MenuProviders, is closed.

onMenuItemSelected

open fun onMenuItemSelected(@NonNull item: @NonNull MenuItem): Boolean

Called whenever one of the menu items from any of the current MenuProviders is selected.

onPrepareMenu

open fun onPrepareMenu(@NonNull menu: @NonNull Menu)

Called right before the given Menu, which was provided by one of the current MenuProviders, is to be shown.

removeMenuProvider

open fun removeMenuProvider(@NonNull provider: @NonNull MenuProvider)

Removes the given MenuProvider from the helper.